BCI NET 2

home *** CD-ROM | disk | FTP | other *** search

/ BCI NET 2 / BCI NET 2.iso / archives / telecomm / bbs / rontools3.lha / Ron-Tools.No3 / ChatPage / Docfiles / ChatPage.doc next >

Wrap

Text File | 1994-12-12 | 16.6 KB | 545 lines

______ __ __ ______ / __ // / _/ /_ / __ / / / -'/ /___ ______ / __// /_/ /______ ______ ______ / / / __ // __ / / / / ____// __ / / __ // ____/ / /___ / / / // __ / / /_ / / / __ / / /_/ // __/_ \____//_/ /_//_/ /_/ /___//_/ /_/ /_/ _\__ //_____/ /_____/ V1.00 The One and Only XenoLink ChatDoor!! (c)1992-1994 by Ron Klinkien -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- ABOUT: ~~~~~ This package contains a ChatDoor and some Utils for XenoLink BBS Pro. ( V1.95 ). It includes a ChatPager with two buildin Chatters ( a FullScreen and a Split- Screen Chatter ), and some utils to play sounds, change settings etc ... COPYRIGHTS: ~~~~~~~~~~ This software is released as Public Domain software and is freely distributable. ( So NO 'ShareWare' Strings attached ;-) ) REQUIREMENTS: ~~~~~~~~~~~~ Any Amiga with WB2.04 and XenoLink BBS Pro V1.95 running on it. PACKAGE CONTENTS: ~~~~~~~~~~~~~~~~ This package contains the following directories: ----------------------------- The root directory: ------------------------------ - ChatPage The Main Program containing the Chatters and Pager. - DSound A 3rd party 8svx sound player. ---------------------------- The Config directory: ----------------------------- ( These files should be installed in XCONFIG:ChatPage/ ) - ChatPage.cfg The config file holds all main parameters for ChatPage. - ChatPage.cfg.Dutch Dutch version of main config file. - BadUsers.cfg This file contains a list of Users which are never allowed to Page the SysOp. - GreatUsers.cfg This file contains the Users which are allways allowed to Page the SysOp. - Macros.cfg Put your favorite macros here to use in the FullScreen- chatter. - Messages.cfg This new configfile holds the messages for the listview gadget in the requester. -------------------------- The TextScreens directory: -------------------------- ( These files should be installed in DOORS:ChatPage/TextScreens/ ) This directory contains some screen examples, view them with an ansi editor. They are optional. If ChatPage finds a screen for a given hour it displays it instead of the normal buildin text strings. ---------------------------- The Samples directory: ---------------------------- ( These files should be installed in DOORS:ChatPage/Samples/ ) This directory contains some audio sample examples, you can play them with the supplied 8svx player. These files are optional, they are used with the 3rd Party Soundplayer DSound. ---------------------------- The Docfiles directory: --------------------------- ( These files can be installed in DOORS:ChatPage/Docfiles/ ( if you want to ) ) - QuickSetup.doc The installation part of ChatPage.doc - ToDo.txt Some future thoughts :) - ChatPage.doc Yep, you're reading it now ;-) - History.txt Describing the life of my Chatter. ---------------------------- The ChatUtils directory: --------------------------- ( These files can be installed somewhere in your path ( if you want to ) ) - PageStat Executable to alter the PageStatus ( with small GUI ) - PageENV Executable to alter the PageStatus ( for use from Shell ) - PageLogIn Executable to run as CliDoor to Display ChatStatus to User at LogIn. INSTALLATION: ~~~~~~~~~~~~ Read the QuickSetup.doc for this. EXPLAINING THE CONFIG FILES: ~~~~~~~~~~~~~~~~~~~~~~~~~~~ XCONFIG:ChatPage/ChatPage.cfg ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ # # ChatPage V1.00 ©1992-1994 Ron Klinkien # Main Configuration file... (ENGLISH VERSION) # OnBBSScreen ACT This entry will determine on which screen the Pager window will be opened on. YES - the window will be opened on the Xenolink screen of the Node thats Paging. NO - the default PublicScreen (WorkBench) will be used for that... ACT - the active window will be used to open on... BeepPause 80 This number will be the delay between the DisplayBeeps in 50th of a Second.. You only have to change it if you play very long samples... LogFile 2 The verbosity of the LogFile(s) 0 - There will not be any LogFile written... 1 - Only ChatPage Calls (If possible with Page Reason) 2 - The above including a Capture file that will be written to the XLOG:ChatPage/ The Filename will be the UserName of the User Chatting... AskReason YES Ask the User for a ChatReason before Paging..? NO - Yep, you guessed it right.. YES - He must fill in something... ALWAYS - Even if you are not available he can fill in something, so you can read it in the logfile afterwards... ANSIMenu 1 This value stands for the lowest ANSI(Color) menu you have set up. eg. With menus higher than 1 ChatPage will use color output, below 1 the output is b&w... WriteMsg 3 You can let ChatPage write AutoPost to you, when you have not answered the call. 0 - Never write AutoPost. 1 - Only when available but not answered calls... 2 - Write always a message when someone is trying to page you... 3 - Start External Editor when Exiting ChatPage (see also EditorKey Flag) MSGSection 0 This is the message section to let ChatPage write the mail to. (Must be a Local Msg Area. eg. Sysop Only area...) SysOpName RON_KLINKIEN Fill in your own name here! To this person the Msgs will be written to.. (Watch the "_" instead of spaces!!) SysOpInit SYS> The initials which will be used for you in the FullScreen Chatter... Comment out this line in the config to let ChatPage calculate your initials out of your UserName... UserColor 2 The Color of the Text typed in by the User in the FullScreen Chatter (0-7) SysOpColor 7 The same for the Text typed by you... (0-7) UseMacros YES Use Macros in the FullScreenChatter (see Macros.cfg) EditorKey L The MenuKey in your BBS-menus to start 'Leave Comment to SysOp...' NOTE: This must be the same in all the menus where ChatPage can be started from. YesKey y The "Yes" key to answer questions with... (Remember to change the question lines accordingly) NoKey n The "No" key to answer questions with... (Remember to change the question lines accordingly) SoundPlayer DOORS:ChatPage/DSound -2 -w DOORS:ChatPage/Samples/Bullfrog Here you can place your own event which will be activated during paging. You can use the suplied DSound 8svx sound player. Or execute an arexx program to activate upd, or an module player. If you leave this entry blank, the normal displaybeep () will be used to page you. The next entries are Text Configs for various Questions inside ChatPage... I'll think they explain thereself... DontKnow Don't you know a better reason to Chat? PressReturn Press any Key to Return to the BBS! ReallyCall Do you Really want to Call the SysOp? (Y/n) CallAgain Do you want to Call the SysOp again ? (y/N) PressToCont Press any Key to Continue... WritingMSG Writing message to the SysOp... WritingDBG Writing Config-Settings to File... DumpDBG Do you want to Dump the Config to a File? (y/N) CallSysOp Let's call the SysOp right Now! QuestLine1 Hello QuestLine2 Tell me, what do you want to Chat about? ChatHello Hello! The SysOp is now Online for a Chat... ChatQuit Quit this Chat session? (Y/n) AskChat Enter a ChatReason anyway? (Y/n) UseEditor Would you like to Write a Msg to the SysOp? (y/N) The following part configures the buildin scheduler of ChatPage. # The Scheduler Config Part # . = Available, S = Sleeping, B = Busy, N = Not Home, T = TimeList (UnAvail) # # 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 # 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 Sun SSSSSSSSSSSSSSSSSSS...........................SS Mon SSSSSSSSSSSSSSSTTTTTTTTTTTTTTTTTTT............SS Tue SSSSSSSSSSSSSSSTTTTTTTTTTTTTTTTTTT............SS Wed SSSSSSSSSSSSSSSTTTTTTTTTTTTTTTTTTT............SS Thu SSSSSSSSSSSSSSSTTTTTTTTTTTTTTTTTTT............SS Fri SSSSSSSSSSSSSSSTTTTTTTTTTTTTTTTTTT............SS Sat SSSSSSSSSSSSSSSSSSS...........................SS There is an entry for each half-hour! . = Available, S = Sleeping, B = Busy, N = Not Home, T = TimeList (UnAvail) The following lines are displayed when you are Not Available or have Not Answered the Call, and no TextScreen is available in the ChatPage/Screens directory... # AV = Available, SL = Sleeping, BS = Busy, NH = NotHome (Max 70 Chars/Line) AV The SysOp is not around. AV Please try again later today. AV Or you can leave a message if you want. Etc, Etc.. 3 lines/Entry.. Max 70 Chars/Line These lines will be automagically centered, so don't worry ;-)... XCONFIG:ChatPage/BadUsers.CFG ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ # # ChatPage V1.00 ©1992-1994 Ron Klinkien # BadUsers Configuration file... # # These Users will Never disturb you... ;) Harry_the_hacker The_Police Etc_Etc If you have users you don't wanna Chat with, add their names to this list... ;-) This way you will always be unavailable for them.. (Watch the "_" instead of Spaces!) If you don't wanna use this feature you can delete this file or leave it empty, this option will then be ignored. XCONFIG:ChatPage/GreatUsers.CFG ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ # # ChatPage V1.00 ©1992-1994 Ron Klinkien # GreatUsers Configuration file... # # These Users can Always disturb you... ;( ;) Jonathan_Forbes ;-) All_Xenolink_SysOps Etc_Etc Only _these people_ can always page you... ;) THE PAGESTAT UTIL: ~~~~~~~~~~~~~~~~~ Run PageStat to set the Page Status... It will open on your WorkBench screen (this will change when Z4 is alive) In the iconified titlebar you see you current status: TL for Timelist (Not Available) \ SL for Sleeping ( " " ) BS for Busy ( " " ) (except for Users listed in GreatUsers.CFG) NH for Not Home ( " " ) / AV for Available (except for Users listed in BadUsers.CFG) SH for using the Scheduler When you want to change your Page Status in Shell/CLI mode or by an Cron Utility at any time you want, the only thing you have to do is set the ENV: variable to one of the following: SetENV ChatStatus TIMELIST (When you want to use the 3-line msgs from ChatPage.CFG or display the screens if they exists) ASLEEP (When you are Sleeping ZZZzzz)... NOTHOME (When you are at the pub ;-) VERY BUSY (When you are Very Busy with your GirlFriend ;-) SCHEDULER (When you want ChatPage to use its scheduler) SetENV ChatStatus "" (to set the Status to Available...) THE PAGEENV UTIL: ~~~~~~~~~~~~~~~~ If you want to set the ChatStatus ENV from a Cron file use this executable. I have written this small util to save the Variable also to ENVARC: since SetENV only sets the ENV: part... And after a reboot the status was lost... When you want to change your Page Status in Shell/CLI mode or by an Cron Utility at any time you want, the only thing you have to do is set the ENV: variable to one of the following: PageENV >NIL: AV - You are available... SL - Sleeping zzzZZZZ... NH - Not Home... BS - Very Busy... TL - Not Available, use 3line Msgs from .cfg file... SH - Use scheduler THE PAGELOGIN UTIL: ~~~~~~~~~~~~~~~~~~ I have written this util in a few minutes to use in my script when a user logs in. They can see what the status of chatpage is without starting ChatPage... Run it with CLIDoor "Xenolink:Utilities/3rdparty/PageLogIn" in your MainMenu (if you have made a fake mainmenu you can use this otherwise this util is useless) TEXTSCREENS: ~~~~~~~~~~~ Instead of the small three line msgs configured in the ChatPage.CFG you can use full height ANSI/TXT screens!! The only thing you have to do is create those screens and put them in the DOORS:ChatPage/Screens/ directory... Their name could be xx.TXT or xx.GR1 Where 'xx' can be one of the following: SL, AV, BS, NH, VB and 00 through 23 also BYE.TXT or BYE.GR1 is used which will be displayed after chatting... When the User online has ANSI enabled the .GR1 screens will be used, if that doesn't exists the .TXT file will be displayed... So you can max. make 60 screens!! Fire up those ANSI editors ;-) But you can also use only a few (the important ones) offcourse.. its up to you. THE SPLITSCREEN CHATTER: ~~~~~~~~~~~~~~~~~~~~~~~ With this chatter the User and the SysOp can type at the same time, the screen is divided in two smaller sections the upper one for u and the lower one for the User. When you start the Chatter (either by starting SplitChat or clicking the SplitChat button in the Pager requester) you also see a little window in the upper right corner of your screen, this is used to get the SysOp text input (Idea by Wim Rumping) it must therefore be active when YOU type! NOTE: This is not one of the most efficient ways, but I don't know if and how the GetKeyBoardMsg routine works (I'll hope this is fixed in Z4!!) Is it JF? EXIT CHAT: You (or the User) can Quit the SplitChatter by typing a / on an empty line. THE FULLSCREEN CHATTER: ~~~~~~~~~~~~~~~~~~~~~~~ This is a 'one at a time' chatter like the buildin chatter, except that this one features initials before the lines, and a Buffered Capture Function... You can start it by starting FullChat, or by clicking the FullChat button in the Pager requester... Some welcome line will be displayed and you can start typing, to change the chat- person type 2x return key... EXIT CHAT: You (or the User) can Quit the FullChatter by typing a / on an empty line. BUFFERED CAPTURE FILE: ~~~~~~~~~~~~~~~~~~~~~ The Full- and the SplitScreen Chatter use both an Buffered Capture File... The ChatText will be stored in XLOG:ChatPage/<User_Name>.LOG and is buffered with a 8Kb buffer... You can Dis/Enable this option with the LogFile Flag in ChatPage.cfg DEBUGGING OPTIONS: ~~~~~~~~~~~~~~~~~ If you feel that the settings are not functioning the way it should be, you can generate an debug file by Starting ChatPage yourself (with level 255) and answer 'No' to 'Do you Really want to Call the SysOp? (Y/n)' then answer 'Yes' to 'Do you want to Dump the Config to a File? (y/N)' then examine the XLOG:ChatPage/ChatPage.dbg file and check it against your ChatPage.CFG file... RETURN CODES: ~~~~~~~~~~~~ When the Pager or the Chatters are quitting without doing anything usefull check your CALL-x.LOG file for the return codes of them... These are implemented: 0 - Everything is OK so don't worry...be happy ;) 1 - Needs KS2.04 or higher to work. 2 - Not started as a Xenolink Door 3 - Could not open XCONFIG:ChatPage/ChatPage.CFG file... 4 - Could not open the xenolink.library... 5 - Could not get the Shared Data 6 - Could not open the gadtools.library V37+... 7 - LostCarrier() while asking for Chatreason! 8 - Cannot open the Pager Window on the PublicScreen. 9 - LostCarrier() while Paging for SysOp. 10 - Cannot create/write DEBUG info to XLOG:ChatPage/ChatPage.DBG 11 - LostCarrier() by SysOp while SplitChatting 12 - LostCarrier() by User while SplitChatting 13 - LostCarrier() while FullChatting... 14 - Cannot create/write XLOG:ChatPage/ChatPage.LOG 15 - Cannot create/write Capture File... 16 - Cannot AllocVec for File Buffer... 17 - Cannot lock Public Screen... 18 - Cannot get the Visual Info 19 - Cannot Create Context 20 - Cannot open Pager Window on BBS Screen 21 - Out of Memory while Creating MacroList 22 - Out of Memory while Creating MacroNodes... 23 - Out of Memory while Creating MessageList... 24 - Out of Memory while Creating MessageNode... BUGS: ~~~~ Known Bugs... This package has so far been tested on a A500/68010/3.5MBMEM/KS2.04/WB2.1 and on a A2000/A2630/7MBMEM/KS3.1/WB3.1 system... No Enforcer or Mungwall hits detected so far ;) ... HOW TO REACH THE AUTHOR: ~~~~~~~~~~~~~~~~~~~~~~~ Ron Klinkien Amiga Hardware BBS The Netherlands (Europe) Phone +31-(0)1840-17373 (BBS) 24Hrs/Day USRobotics V34 DualStd, IBM 0662 1.05Gb & Conner 540Mb HD Online Featuring: GnuCC, '030/040 utils, TeX/PS, Hardware Hacks, JPeg/HAM8 Pics, Linux68K & New AmiNet RECENT file every weekend! ... Write a message in the XENOLINK FidoEchos... or address an NetMail Message to: FIDONet: 2:285/302 NLANet: 14:100/103 GERNet: 21:103/33 E-Mail: ron@ahwbbs.xs4all.nl o Any suggestions, Bug Reports? Let's hear them... ;-) THANKS TO: ~~~~~~~~~ Tom de Ruyter, Frank Sloep and Roy Aberkrom for their PostCards!